Skip to main content

What is Markdown Language?

Markdown is a lightweight markup language. It is used to create formatted text using simple text editor.

Github supports Markdown and thats why we are going to create this documentation in .md file.

  • Content:
    • Basic syntax.
    • Advanced syntax.

-----------------------------------------------------

Basic Syntax :

  • HEADERS (H1 to H6)

#  h1 tag
##  h2 tag
###  h3 tag

Output

h1 tag

h2 tag

h3 tag

-----------------------------------------------------

*This is italic*
_This is also italic_
**This is bold**
__This is also bold__

Output

This is italic

This is also italic

This is bold

This is also bold -----------------------------------------------------

  • BLOCKQUOTES

    > this is a single block quote.
    >> this is a nested block quote.
## Output
> this is a single block quote.
>> this is a nested block quote.

![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

- ## LIST
- ### Ordered List :
  1. First item
  2. Second item
## Output
  1. First item
  2. Second item

 - ### Unordered List :

  • First item

  • Second item

    ## Output

  • First item

    • Second item

-----------------------------------------------------

  • HORIZONTAL RULE

---

Output

-----------------------------------------------------

  `This is a code`

Output

This is a code

More Examples :

Highlighted C Codes:

  ```c
  Printf("Hello World!");

Output

Printf("Hello World!");

Highlighted HTML Codes:

  ```html
  <!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>

</body>
</html>

Output

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>Document</title>
</head>
<body>

</body>
</html>

-----------------------------------------------------

Normal link Syntax:
[title](https://www.example.com)

Example:
[Github](https://www.github.com)

Emails Syntax:
<email id>

Example:
<xyz@gmail.com>

Output :

Github

xyz@gmail.com

-----------------------------------------------------

Syntax:
![image name](image address)

Example:
![github-octocat](https://user-images.githubusercontent.com/87390353/139872522-9706b6aa-06cf-480f-b26d-0b7e0aaa7214.png)

Output :

github-octocat

-----------------------------------------------------

Advanced Syntax :

Syntax:  :short code:
Example : :laughing:

Output :

😆

-----------------------------------------------------

Here's a sentence with a footnote. [^1]

[^1]: It is the footnote.

Here's a sentence with a footnote. 1 1: It is the footnote.

-----------------------------------------------------

  • STRIKE THROUGH

Syntax:
~~Sentence~~

Example:
~~You are a bad student.~~

Output :

This sentence is incorrect

-----------------------------------------------------

Reference:

Github Markdown

Keep Learning !